.\"
.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
.\" permission to reproduce portions of its copyrighted documentation.
.\" Original documentation from The Open Group can be obtained online at
.\" http://www.opengroup.org/bookstore/.
.\"
.\" The Institute of Electrical and Electronics Engineers and The Open
.\" Group, have given us permission to reprint portions of their
.\" documentation.
.\"
.\" In the following statement, the phrase ``this text'' refers to portions
.\" of the system documentation.
.\"
.\" Portions of this text are reprinted and reproduced in electronic form
.\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
.\" Standard for Information Technology -- Portable Operating System
.\" Interface (POSIX), The Open Group Base Specifications Issue 6,
.\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
.\" Engineers, Inc and The Open Group.  In the event of any discrepancy
.\" between these versions and the original IEEE and The Open Group
.\" Standard, the original IEEE and The Open Group Standard is the referee
.\" document.  The original Standard can be obtained online at
.\" http://www.opengroup.org/unix/online.html.
.\"
.\" This notice shall appear on any product containing this material.
.\"
.\" The contents of this file are subject to the terms of the
.\" Common Development and Distribution License (the "License").
.\" You may not use this file except in compliance with the License.
.\"
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
.\" or http://www.opensolaris.org/os/licensing.
.\" See the License for the specific language governing permissions
.\" and limitations under the License.
.\"
.\" When distributing Covered Code, include this CDDL HEADER in each
.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
.\" If applicable, add the following below this CDDL HEADER, with the
.\" fields enclosed by brackets "[]" replaced with your own identifying
.\" information: Portions Copyright [yyyy] [name of copyright owner]
.\"
.\"
.\" Copyright 1989 AT&T.
.\" Copyright (c) 2001, The IEEE and The Open Group.  All Rights Reserved.
.\" Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
.\"
.TH WAIT.H 3HEAD "Sep 10, 2004"
.SH NAME
wait.h, wait \- wait status
.SH SYNOPSIS
.LP
.nf
\fB#include <sys/wait.h>\fR
.fi

.SH DESCRIPTION
.sp
.LP
When a process waits for status from its children using either the
\fBwait\fR(3C) or \fBwaitpid\fR(3C) function, the status returned can be
evaluated with the following macros, defined in <\fBsys/wait.h\fR>. These
macros evaluate to integral expressions. The \fIstat\fR argument to these
macros is the integer value returned from \fBwait()\fR or \fBwaitpid()\fR.
.sp
.ne 2
.na
\fB\fBWCOREDUMP\fR(\fIstat\fR)\fR
.ad
.RS 22n
If the value of \fBWIFSIGNALED\fR (\fIstat\fR) is non-zero, this macro
evaluates to a non-zero value if a core image of the terminated child was
created.
.RE

.sp
.ne 2
.na
\fB\fBWEXITSTATUS\fR(\fIstat\fR)\fR
.ad
.RS 22n
If the value of  \fBWIFEXITED(\fR\fIstat\fR\fB)\fR is non-zero, this macro
evaluates to the exit code that the child process passed to  \fB_exit()\fR (see
\fBexit\fR(2)) or \fBexit\fR(3C), or the value that the child process returned
from \fBmain\fR.
.RE

.sp
.ne 2
.na
\fB\fBWIFCONTINUED\fR(\fIstat\fR)\fR
.ad
.RS 22n
Evaluates to a non-zero value if status was returned for a child process that
has continued.
.RE

.sp
.ne 2
.na
\fB\fBWIFEXITED\fR(\fIstat\fR)\fR
.ad
.RS 22n
Evaluates to a non-zero value if status was returned for a child process that
terminated normally.
.RE

.sp
.ne 2
.na
\fB\fBWIFSIGNALED\fR(\fIstat\fR)\fR
.ad
.RS 22n
Evaluates to a non-zero value if status was returned for a child process that
terminated due to the receipt of a signal.
.RE

.sp
.ne 2
.na
\fB\fBWIFSTOPPED\fR(\fIstat\fR)\fR
.ad
.RS 22n
Evaluates to a non-zero value if status was returned for a child process that
is currently stopped.
.RE

.sp
.ne 2
.na
\fB\fBWSTOPSIG\fR(\fIstat\fR)\fR
.ad
.RS 22n
If the value of \fBWIFSTOPPED(\fR\fIstat\fR\fB)\fR is non-zero, this macro
evaluates to the number of the signal that caused the child process to stop.
.RE

.sp
.ne 2
.na
\fB\fBWTERMSIG\fR(\fIstat\fR)\fR
.ad
.RS 22n
If the value of  \fBWIFSIGNALED\fR(\fIstat\fR) is non-zero, this macro
evaluates to the number of the signal that caused the termination of the child
process.
.RE

.sp
.LP
The <\fBsys/wait.h\fR> header defines the symbolic constants listed below for
use with \fBwaitpid\fR(3C).
.sp
.ne 2
.na
\fB\fBWNOHANG\fR\fR
.ad
.RS 13n
Do not hang if no status is available; return immediately.
.RE

.sp
.ne 2
.na
\fB\fBWUNTRACED\fR\fR
.ad
.RS 13n
Report status of stopped child process.
.RE

.sp
.LP
The symbolic constants listed below are defined as possible values for the
\fIoptions\fR argument to \fBwaitid\fR(2).
.sp
.ne 2
.na
\fB\fBWEXITED\fR\fR
.ad
.RS 14n
Wait for processes that have exited.
.RE

.sp
.ne 2
.na
\fB\fBWSTOPPED\fR\fR
.ad
.RS 14n
Status is returned for any child that has stopped upon receipt of a signal.
.RE

.sp
.ne 2
.na
\fB\fBWCONTINUED\fR\fR
.ad
.RS 14n
Status is returned for any child that was stopped and has been continued.
.RE

.sp
.ne 2
.na
\fB\fBWNOHANG\fR\fR
.ad
.RS 14n
Return immediately if there are no children to wait for.
.RE

.sp
.ne 2
.na
\fB\fBWNOWAIT\fR\fR
.ad
.RS 14n
Keep the process whose status is returned in \fBinfop\fR in a waitable state.
.RE

.sp
.LP
The type \fBidtype_t\fR is defined as an enumeration type whose possible values
include the following:
.sp
.in +2
.nf
P_ALL
P_PID
P_PGID
.fi
.in -2

.sp
.LP
The \fBid_t\fR and \fBpid_t\fR types are defined as described in
<\fBsys/types.h\fR>.
.sp
.LP
The \fBsiginfo_t\fR type is defined as described in <\fBsignal.h\fR>.
.sp
.LP
The \fBrusage\fR structure is defined as described in <\fBsys/resource.h\fR>.
.sp
.LP
Inclusion of the <\fBsys/wait.h\fR> header can also make visible all symbols
from <\fBsignal.h\fR> and <\fBsys/resource.h\fR>.
.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(7) for descriptions of the following attributes:
.sp

.sp
.TS
box;
c | c
l | l .
ATTRIBUTE TYPE	ATTRIBUTE VALUE
_
Interface Stability	Standard
.TE

.SH SEE ALSO
.sp
.LP
.BR exit (2),
.BR waitid (2),
.BR exit (3C),
.BR wait (3C),
.BR waitpid (3C),
.BR attributes (7),
.BR standards (7)
